home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 5 / Amiga Tools 5.iso / tools / developer-tools / c-tools / c_examples / textdt / sampletext / readme.before.upload < prev    next >
Encoding:
Text File  |  1996-02-21  |  7.6 KB  |  183 lines

  1.                           UPLOADING INSTRUCTIONS
  2.                           ======================
  3.  
  4. To those who never fully read the README's:  Upload foo.readme for foo.lha,
  5. where foo.readme contains they keyword Short:  plus a 40 character
  6. description on the first line. Don't upload if CD releasees are a problem.
  7.  
  8. All others please read below instructions carefully, or your upload is in
  9. danger of being deleted.  Uploading to Aminet is a bit more complicated
  10. than to other places since it's a network of sites and provides more info
  11. about files. It's a bit of work for you, but it saves a lot of hassle to
  12. the many, many downloaders.
  13.  
  14.  
  15.                               WHAT TO UPLOAD
  16.                               --------------
  17.  
  18. This FTP site is intended for the distribution of any type of freely 
  19. distributable software. However, due do copyright laws and internet 
  20. provider restrictions, we have to set the following conditions:
  21.  
  22. DO NOT UPLOAD:
  23. - Commercial software
  24. - Files from the Commodore Workbench disks
  25. - Software that is not OK to distribute on CD (see below for exceptions)
  26. - Samples from copyrighted CD's, TV or radio broadcasts
  27. - Musical mods that are cover versions from copyrighted songs
  28. - Images or animations from copyrighted image sources
  29. - Images depicting persons who didn't agree with the distribution
  30. - Images of sexual content
  31. - GNU software without sources
  32. - Strong cryptography (key length >40 bit)
  33. - DMS files
  34.  
  35. Please respect these conditions, or you could bring Aminet in danger of
  36. being shut down.
  37.  
  38.  
  39.                               WHERE TO UPLOAD
  40.                               ---------------
  41.  
  42. Aminet consists of about 20 FTP sites and 60 BBSes that exchange their files.
  43. The center of the net is wuarchive.wustl.edu [128.252.135.4].  If possible,
  44. upload there.  Most other sites (ftp.uni-paderborn.de recommended for 
  45. Europeans) forward the files to that site and delete them locally, they'll 
  46. be mirrored back later. Do not upload the same file to multiple Aminet sites.
  47.  
  48. There are two upload directories on Aminet sites:
  49.  
  50.   pub/aminet/new    for public uploads
  51.   pub/aminet/priv   for private uploads   (local to this site)
  52.  
  53. Uploads in new/ that have no .readme will be deleted since they could be 
  54. commercial or otherwise suspect.  If your upload appears in RECENT
  55. within 4 days, everything was fine (don't delete your copy before that 
  56. happens!). If not, contact aminet@wuarchive.wustl.edu 
  57.  
  58. If you provided an Uploader: field, you'll get a mail if we deleted your 
  59. upload for any reason (e.g. because it was corrupt).
  60.  
  61.  
  62.                               PUBLIC UPLOADS
  63.                               --------------
  64.  
  65. The main difference between Aminet and most other ftp sites is that all
  66. uploads have a description.  They're collected automatically and listed in
  67. RECENT and INDEX.  These short (40 characters) descriptions come from the
  68. .readme files uploaded along with the binaries.
  69.  
  70. Whenever you upload something, create .readme file for it.  An example:
  71. Along with PictureView.lha you would upload PictureView.readme.  That file
  72. could look about like this (no blank lines at the start, and don't
  73. include the CUT HERE lines):
  74.  
  75.  
  76. --------------------------------CUT HERE------------------------------
  77. Short:    Shows JPEG & IFF pics. AGA support. V1.2
  78. Uploader: umueller@amiga.icu.net.ch (Urban Mueller)
  79. Author:   umueller@amiga.icu.net.ch (Urban Mueller)
  80. Type:     gfx/show
  81.  
  82. This all new picture displayer is capable of showing almost any image
  83. type in any resolution. Main features include:
  84. - Scrolling screens
  85. - CLI and WB interface
  86.  ......
  87. --------------------------------CUT HERE------------------------------
  88.  
  89. The meaning of these fields is:
  90.  
  91. Short:        is the only mandatory field, and has to be in the first
  92.               line. It lets you specify a 40 character description of your
  93.               upload, that will be seen and INDEX and RECENT so everyone 
  94.               can easily learn about your upload. Don't repeat the file 
  95.               name here, but if several versions of your archive exist, 
  96.               specify the version number here. Try to explain what the 
  97.               program *does*. Music should specify the style.
  98.  
  99. Uploader:     lets you indicate your email address so we can contact you
  100.               if something goes wrong (and this happens more often than 
  101.               you think). Please always provide it.
  102.  
  103. Author:       is the place where you can indicate who created the piece of
  104.               software you uploaded.
  105.  
  106. Type:         is the place where you can propose a directory where the file
  107.               should be moved. Check the file TREE for possible subdirs.
  108.  
  109.  
  110. Now for some completely optional fields:
  111.  
  112. Kurz:         is the German version of Short:
  113.  
  114. Replaces:     lets you specify files that are superseded by your upload.
  115.               Give full path, e.g. biz/patch/PageStreamPatch*
  116.  
  117. Requires:     other archives that your upload needs to work, with full
  118.               path. Also name OS, mem and chipset requirements here.
  119.  
  120. Version:      the version number of your upload. Don't use version 
  121.               numbers in files names if possible.
  122.  
  123. Distribution: lets you specify where your upload is OK to distribute.
  124.               If you specify the 'NoCD' keyword here, your upload will
  125.               not appear on the CD's made of this site. If you specify
  126.               'Aminet', you only give Aminet the distribution permission.
  127.  
  128. After a blank line, you may add a longer description, that could for 
  129. example be the README found inside the archive.  Don't rely on people 
  130. downloading the .readme file, the info found there should be in the 
  131. archive, as well.
  132.  
  133. Notes: 
  134. - If your upload requires a language other than English, please mention
  135.   that language in the Short: description.
  136. - You can overwrite old versions of your uploads by uploading again
  137.   using the same file name. This is the preferred way to do updates.
  138.  
  139.  
  140.                          FILE NAME CONVENTIONS
  141.                          ---------------------
  142.  
  143. The maximum file name length is 18 characters including the archiver suffix
  144. (.lha).  Mixed case is OK, but it should be mainly lowercase. If your
  145. file name is generic (ls, pipe), append your initials (pipe-JU). Version
  146. numbers are better in the Short: descriptions than in the file name. Also, 
  147. please do not upload in any other file format than .lha except for .jpg 
  148. and .mpg files, which can be uploaded without putting them in archives.
  149. By adhering to these rules you can save a lot of beginners a lot of trouble.
  150.  
  151.  
  152.                                 CHECK LIST
  153.                                 ----------
  154.  
  155. - Are the archives okay? Use UNIX LhA to find out.
  156. - Is there a .readme for *every* file you are about to upload?
  157. - Are the base names of the .readme and the archive the same? Same case?
  158. - Are all archive names 18 characters or shorter?
  159. - Is there a Short: and if possible an Uploader: field in the .readme's?
  160. - Does none of the archives contain copyrighted or Workbench material?
  161. - Is the archive free of BBS ads?
  162.  
  163. Thanks for checking, you're saving us a lot of work.
  164.  
  165.  
  166.                             PRIVATE UPLOADS
  167.                             ---------------
  168.  
  169. You may upload files that are not meant to be available to the public to
  170. /amiga/priv.  Files in there can not be listed, so you have to tell your
  171. partner the precise file name.  Files remain available at least one week,
  172. much longer in most cases.  Note that we don't give any warranties about
  173. the privacy of the files in there, encrypt them if you like.
  174.  
  175.  
  176.  
  177.                              YOUR COMMENTS
  178.                              -------------
  179.  
  180. If you have any comments about the policies given, or if you see 
  181. suspicious, commercial or corrupt files, please immediately send mail 
  182. to aminet@aminet.org
  183.